/*******************************************************************************
 * Copyright 2009, 2010 Innovation Gate GmbH. All Rights Reserved.
 * 
 * This file is part of the OpenWGA server platform.
 * 
 * OpenWGA is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * In addition, a special exception is granted by the copyright holders
 * of OpenWGA called "OpenWGA plugin exception". You should have received
 * a copy of this exception along with OpenWGA in file COPYING.
 * If not, see <http://www.openwga.com/gpl-plugin-exception>.
 * 
 * OpenWGA is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with OpenWGA in file COPYING.
 * If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/

package de.innovationgate.wga.server.api.tml;

import java.util.Map;

import de.innovationgate.webgate.api.WGException;
import de.innovationgate.wga.common.CodeCompletion;

/**
 * A server-side Websocket endpoint, used to communicate with Websocket client
 */
@CodeCompletion(methodMode=CodeCompletion.MODE_EXCLUDE)
public interface WebSocket {
    
    /**
     * Fire a portlet event to Websocket client.
     * Will only work if the client is an HTML page (or listens to portlet event messages)
     * @param eventName The portlet event name
     * @param params Event parameters
     * @throws WGException 
     */
    public void firePortletEvent(String eventName, Map<String,Object> params) throws WGException;

    /**
     * Send a custom message to to the Websocket client.
     * @param data
     */
    void sendMessage(Map<String, Object> data) throws WGException;

}
